<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit - Firmware API: debugosc.c Source File</title>
<link href="mt_doxygen.css" rel="stylesheet" type="text/css" />
<link href="../resources/mt_doxytabs.css" rel="stylesheet" type="text/css" />
<style type="text/css">
<!--
.header {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 12pt;
	color: #222222;
}
-->
</style>
</head>

<body>
<table width="800" border="0">
    <tr>
      <td colspan="3">
        <form method="get" action="http://www.google.com/search">
          <div align="right">
            <input type="text"   name="q" size="25"
              maxlength="255" value="" />
            <input type="submit" value="Search" />
            <input type="hidden" name="sitesearch" value="makingthings.com/ref/firmware/html" />
          </div>
        </form>
       </td>
    </tr>
    <tr>
      <td><div align="center"><a href="http://www.makingthings.com">
				<img src="../resources/logo_brown_medium.png" alt="MakingThings"
									width="200" height="78" border="0" align="middle" longdesc="http://www.makingthings.com" /></a></div></td>
				<td><div align="center" class="header">
      		Make Controller Kit <br />
          Firmware API
      </div></td>
      <td><div align="center"><a href="http://www.makezine.com">
					<img src="../resources/make_logo.png" alt="MAKE Zine" 
										width="164" height="73" border="0" align="middle" longdesc="http://www.makezine.com" /></a></div></td>
    </tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.5.4 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
  var num=this.id.replace(/[^[0-9]/g,'');
  var button=this.firstChild;
  var sectionDiv=document.getElementById('dynsection'+num);
  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
    sectionDiv.style.display='block';
    button.src='open.gif';
  }else{
    sectionDiv.style.display='none';
    button.src='closed.gif';
  }
}
function initDynSections(){
  var divs=document.getElementsByTagName('div');
  var sectionCounter=1;
  for(var i=0;i<divs.length-1;i++){
    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
      var header=divs[i];
      var section=divs[i+1];
      var button=header.firstChild;
      if (button!='IMG'){
        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
        button=document.createElement('img');
        divs[i].insertBefore(button,divs[i].firstChild);
      }
      header.style.cursor='pointer';
      header.onclick=changeDisplayState;
      header.id='dynheader'+sectionCounter;
      button.src='closed.gif';
      section.id='dynsection'+sectionCounter;
      section.style.display='none';
      section.style.marginLeft='14px';
      sectionCounter++;
    }
  }
}
window.onload = initDynSections;
-->
</script>
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>debugosc.c</h1><a href="debugosc_8c.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*********************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Copyright 2006 MakingThings</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> Licensed under the Apache License, </span>
<a name="l00006"></a>00006 <span class="comment"> Version 2.0 (the "License"); you may not use this file except in compliance </span>
<a name="l00007"></a>00007 <span class="comment"> with the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> http://www.apache.org/licenses/LICENSE-2.0 </span>
<a name="l00010"></a>00010 <span class="comment"> </span>
<a name="l00011"></a>00011 <span class="comment"> Unless required by applicable law or agreed to in writing, software distributed</span>
<a name="l00012"></a>00012 <span class="comment"> under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR</span>
<a name="l00013"></a>00013 <span class="comment"> CONDITIONS OF ANY KIND, either express or implied. See the License for</span>
<a name="l00014"></a>00014 <span class="comment"> the specific language governing permissions and limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">*********************************************************************************/</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment">/** \file debugosc.c  </span>
<a name="l00019"></a>00019 <span class="comment">  Controller Debug.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="preprocessor">#include "config.h"</span>
<a name="l00023"></a>00023 <span class="preprocessor">#ifdef OSC</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "debug.h"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;stdio.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "osc.h"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;stdarg.h&gt;</span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="preprocessor">#define DEBUG_MAX_MESSAGE 100</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="keyword">typedef</span> <span class="keyword">struct </span>Debug_
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034   <span class="keywordtype">int</span> users;
<a name="l00035"></a>00035   <span class="keywordtype">int</span> level;
<a name="l00036"></a>00036   <span class="keywordtype">int</span> usb;
<a name="l00037"></a>00037   <span class="keywordtype">int</span> udp;
<a name="l00038"></a>00038   <span class="keywordtype">char</span> message[ DEBUG_MAX_MESSAGE ];
<a name="l00039"></a>00039 } DebugStruct;
<a name="l00040"></a>00040 
<a name="l00041"></a>00041 DebugStruct* DebugData;
<a name="l00042"></a>00042 <span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment">/** \defgroup Debug</span>
<a name="l00044"></a>00044 <span class="comment">  The Debug subsystem offers a simple way to send debug messages back from the MAKE Controller via OSC.</span>
<a name="l00045"></a>00045 <span class="comment">  Even without single-stepping through the code running on the MAKE Controller, it is still easy to get helpful</span>
<a name="l00046"></a>00046 <span class="comment">  debug information about the program through the Debug subsystem.</span>
<a name="l00047"></a>00047 <span class="comment">  </span>
<a name="l00048"></a>00048 <span class="comment">  Specify the level of each debug message and then, in a debug session, set the level you would like to see.  More </span>
<a name="l00049"></a>00049 <span class="comment">  frequent and lower level messages can be filtered out in a debug session by setting the debug</span>
<a name="l00050"></a>00050 <span class="comment">  level a bit higher to let through only the messages you're interested in. </span>
<a name="l00051"></a>00051 <span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment">  Possible levels are:</span>
<a name="l00053"></a>00053 <span class="comment">  - 0 - Always send</span>
<a name="l00054"></a>00054 <span class="comment">  - 1 - Error messages</span>
<a name="l00055"></a>00055 <span class="comment">  - 2 - Warning messages</span>
<a name="l00056"></a>00056 <span class="comment">  - 3 - Normal/test messages</span>
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">  \ingroup Controller</span>
<a name="l00059"></a>00059 <span class="comment">  @{</span>
<a name="l00060"></a>00060 <span class="comment">*/</span>
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">/**</span>
<a name="l00063"></a>00063 <span class="comment">  Sets whether the Debug subsystem is active.</span>
<a name="l00064"></a>00064 <span class="comment">  The Debug system is automatically set to active by making a call to any Debug system function,</span>
<a name="l00065"></a>00065 <span class="comment">  so you don't typically have to worry about doing that.  But, you can set it to inactive</span>
<a name="l00066"></a>00066 <span class="comment">  to recover a bit of space on the heap.</span>
<a name="l00067"></a>00067 <span class="comment">  @param state An integer specifying the active state - 1 (active) or 0 (inactive).</span>
<a name="l00068"></a>00068 <span class="comment">  @return Zero on success.</span>
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment">  \par Example</span>
<a name="l00071"></a>00071 <span class="comment">  \code</span>
<a name="l00072"></a>00072 <span class="comment">  // Checking the debug level sets the system to active.</span>
<a name="l00073"></a>00073 <span class="comment">  int level = Debug_GetLevel();</span>
<a name="l00074"></a>00074 <span class="comment">  // then we can turn it off</span>
<a name="l00075"></a>00075 <span class="comment">  Debug_SetActive( 0 );</span>
<a name="l00076"></a>00076 <span class="comment">  \endcode</span>
<a name="l00077"></a>00077 <span class="comment">*/</span>
<a name="l00078"></a><a class="code" href="group___debug.html#ga064859b9d698661239260fc7ae4b788">00078</a> <span class="keywordtype">int</span> <a class="code" href="group___debug.html#ga064859b9d698661239260fc7ae4b788" title="Sets whether the Debug subsystem is active.">Debug_SetActive</a>( <span class="keywordtype">int</span> state )
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080   <span class="keywordflow">if</span>( state &amp;&amp; DebugData == NULL )
<a name="l00081"></a>00081   {
<a name="l00082"></a>00082     DebugData = <a class="code" href="group___utils.html#g95923aa748602fa0330903fca05ca892" title="Same as Malloc, but keeps trying until it succeeds.">MallocWait</a>( <span class="keyword">sizeof</span>( <span class="keyword">struct</span> Debug_ ), 100 );
<a name="l00083"></a>00083     DebugData-&gt;usb = 1;
<a name="l00084"></a>00084     DebugData-&gt;udp = 1;
<a name="l00085"></a>00085     DebugData-&gt;level = <a class="code" href="group___debug.html#ge8523807c48236b849d94507b9eae38f" title="Used for normal/test messages.">DEBUG_MESSAGE</a>;
<a name="l00086"></a>00086   }
<a name="l00087"></a>00087   <span class="keywordflow">if</span>( !state &amp;&amp; DebugData != NULL )
<a name="l00088"></a>00088   {
<a name="l00089"></a>00089     <a class="code" href="group___utils.html#g6b0be54448d6ce393134400f4b22fa97" title="Free memory from the heap.">Free</a>( DebugData );
<a name="l00090"></a>00090     DebugData = NULL;
<a name="l00091"></a>00091   }
<a name="l00092"></a>00092   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment">/**</span>
<a name="l00096"></a>00096 <span class="comment">  Returns the active state of the Debug subsystem.</span>
<a name="l00097"></a>00097 <span class="comment">  @return State - 1 (active) or 0 (inactive).</span>
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment">  \par Example</span>
<a name="l00100"></a>00100 <span class="comment">  \code</span>
<a name="l00101"></a>00101 <span class="comment">  // Check to see if we're active...</span>
<a name="l00102"></a>00102 <span class="comment">  int active = Debug_GetActive();</span>
<a name="l00103"></a>00103 <span class="comment">  if( active )</span>
<a name="l00104"></a>00104 <span class="comment">    // then do something...</span>
<a name="l00105"></a>00105 <span class="comment">  \endcode</span>
<a name="l00106"></a>00106 <span class="comment">*/</span>
<a name="l00107"></a><a class="code" href="group___debug.html#gb01e4ab7a088fd347436b32c0d0289af">00107</a> <span class="keywordtype">int</span> <a class="code" href="group___debug.html#gb01e4ab7a088fd347436b32c0d0289af" title="Returns the active state of the Debug subsystem.">Debug_GetActive</a>( )
<a name="l00108"></a>00108 {
<a name="l00109"></a>00109   <span class="keywordflow">return</span> DebugData != NULL;
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 <span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment">/** </span>
<a name="l00113"></a>00113 <span class="comment">  Sets the debug level.</span>
<a name="l00114"></a>00114 <span class="comment">  Set to a lower number to get more messages.  Default level is 3.</span>
<a name="l00115"></a>00115 <span class="comment">  @param level An integer specifying the level (from 0-3).</span>
<a name="l00116"></a>00116 <span class="comment">  @return 0 on success</span>
<a name="l00117"></a>00117 <span class="comment"></span>
<a name="l00118"></a>00118 <span class="comment">  \par Example</span>
<a name="l00119"></a>00119 <span class="comment">  \code</span>
<a name="l00120"></a>00120 <span class="comment">  // Set the level to just report error messages.</span>
<a name="l00121"></a>00121 <span class="comment">  Debug_SetLevel( 1 );</span>
<a name="l00122"></a>00122 <span class="comment">  \endcode</span>
<a name="l00123"></a>00123 <span class="comment">*/</span>
<a name="l00124"></a><a class="code" href="group___debug.html#gaabc49f1a610be9aa9965a48fd1a3598">00124</a> <span class="keywordtype">int</span> <a class="code" href="group___debug.html#gaabc49f1a610be9aa9965a48fd1a3598" title="Sets the debug level.">Debug_SetLevel</a>( <span class="keywordtype">int</span> level )
<a name="l00125"></a>00125 {
<a name="l00126"></a>00126   <span class="keywordflow">if</span> ( !<a class="code" href="group___debug.html#gb01e4ab7a088fd347436b32c0d0289af" title="Returns the active state of the Debug subsystem.">Debug_GetActive</a>() )
<a name="l00127"></a>00127     <a class="code" href="group___debug.html#ga064859b9d698661239260fc7ae4b788" title="Sets whether the Debug subsystem is active.">Debug_SetActive</a>( 1 );
<a name="l00128"></a>00128   DebugData-&gt;level = level;
<a name="l00129"></a>00129   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment">/** </span>
<a name="l00133"></a>00133 <span class="comment">  Read the current debugger level.</span>
<a name="l00134"></a>00134 <span class="comment">  @return Level An integer from 0-3 specifying the level.</span>
<a name="l00135"></a>00135 <span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment">  \par Example</span>
<a name="l00137"></a>00137 <span class="comment">  \code</span>
<a name="l00138"></a>00138 <span class="comment">  // Check the current debug level</span>
<a name="l00139"></a>00139 <span class="comment">  int level = Debug_GetLevel( );</span>
<a name="l00140"></a>00140 <span class="comment">  switch( level )</span>
<a name="l00141"></a>00141 <span class="comment">  {</span>
<a name="l00142"></a>00142 <span class="comment">    case DEBUG_ALWAYS:</span>
<a name="l00143"></a>00143 <span class="comment">      // ...</span>
<a name="l00144"></a>00144 <span class="comment">      break;</span>
<a name="l00145"></a>00145 <span class="comment">    case DEBUG_ERROR:</span>
<a name="l00146"></a>00146 <span class="comment">      // ...</span>
<a name="l00147"></a>00147 <span class="comment">      break;</span>
<a name="l00148"></a>00148 <span class="comment">    case DEBUG_WARNING:</span>
<a name="l00149"></a>00149 <span class="comment">      // ...</span>
<a name="l00150"></a>00150 <span class="comment">      break;</span>
<a name="l00151"></a>00151 <span class="comment">    case DEBUG_MESSAGE:</span>
<a name="l00152"></a>00152 <span class="comment">      // ...</span>
<a name="l00153"></a>00153 <span class="comment">      break;</span>
<a name="l00154"></a>00154 <span class="comment">  }</span>
<a name="l00155"></a>00155 <span class="comment">  \endcode</span>
<a name="l00156"></a>00156 <span class="comment">*/</span>
<a name="l00157"></a><a class="code" href="group___debug.html#ga85d6c6d14873ce098a225bf5aab08ab">00157</a> <span class="keywordtype">int</span> <a class="code" href="group___debug.html#ga85d6c6d14873ce098a225bf5aab08ab" title="Read the current debugger level.">Debug_GetLevel</a>( )
<a name="l00158"></a>00158 {
<a name="l00159"></a>00159   <span class="keywordflow">if</span> ( !<a class="code" href="group___debug.html#gb01e4ab7a088fd347436b32c0d0289af" title="Returns the active state of the Debug subsystem.">Debug_GetActive</a>() )
<a name="l00160"></a>00160     <a class="code" href="group___debug.html#ga064859b9d698661239260fc7ae4b788" title="Sets whether the Debug subsystem is active.">Debug_SetActive</a>( 1 );
<a name="l00161"></a>00161   <span class="keywordflow">return</span> DebugData-&gt;level;
<a name="l00162"></a>00162 }
<a name="l00163"></a>00163 <span class="comment"></span>
<a name="l00164"></a>00164 <span class="comment">/**</span>
<a name="l00165"></a>00165 <span class="comment">  Sets whether the Debug subsystem outputs its OSC messages via USB.</span>
<a name="l00166"></a>00166 <span class="comment">  This is enabled by default.  </span>
<a name="l00167"></a>00167 <span class="comment">  @param state An integer specifying whether or not to send over USB - 1 (on) or 0 (off).</span>
<a name="l00168"></a>00168 <span class="comment">  @return Zero on success.</span>
<a name="l00169"></a>00169 <span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment">  \par Example</span>
<a name="l00171"></a>00171 <span class="comment">  \code</span>
<a name="l00172"></a>00172 <span class="comment">  // Turn debugging over USB off.</span>
<a name="l00173"></a>00173 <span class="comment">  Debug_SetUsb( 0 );</span>
<a name="l00174"></a>00174 <span class="comment">  \endcode</span>
<a name="l00175"></a>00175 <span class="comment">*/</span>
<a name="l00176"></a><a class="code" href="group___debug.html#g699ec173477cc72845e9c35d9c521dcb">00176</a> <span class="keywordtype">int</span> <a class="code" href="group___debug.html#g699ec173477cc72845e9c35d9c521dcb" title="Sets whether the Debug subsystem outputs its OSC messages via USB.">Debug_SetUsb</a>( <span class="keywordtype">int</span> state )
<a name="l00177"></a>00177 {
<a name="l00178"></a>00178   <span class="keywordflow">if</span> ( !<a class="code" href="group___debug.html#gb01e4ab7a088fd347436b32c0d0289af" title="Returns the active state of the Debug subsystem.">Debug_GetActive</a>() )
<a name="l00179"></a>00179     <a class="code" href="group___debug.html#ga064859b9d698661239260fc7ae4b788" title="Sets whether the Debug subsystem is active.">Debug_SetActive</a>( 1 );
<a name="l00180"></a>00180   DebugData-&gt;usb = state;
<a name="l00181"></a>00181   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00182"></a>00182 }
<a name="l00183"></a>00183 <span class="comment"></span>
<a name="l00184"></a>00184 <span class="comment">/**</span>
<a name="l00185"></a>00185 <span class="comment">  Returns whether the Debug system is set to send its messages over USB.</span>
<a name="l00186"></a>00186 <span class="comment">  This is enabled by default.</span>
<a name="l00187"></a>00187 <span class="comment">  @return state An integer specifying whether messages will be sent over USB - 1 (enabled) or 0 (disabled).</span>
<a name="l00188"></a>00188 <span class="comment"></span>
<a name="l00189"></a>00189 <span class="comment">  \par Example</span>
<a name="l00190"></a>00190 <span class="comment">  \code</span>
<a name="l00191"></a>00191 <span class="comment">  // Check whether we're sending Debug messages over USB</span>
<a name="l00192"></a>00192 <span class="comment">  int usb_debug = Debug_GetUsb( );</span>
<a name="l00193"></a>00193 <span class="comment">  \endcode</span>
<a name="l00194"></a>00194 <span class="comment">*/</span>
<a name="l00195"></a><a class="code" href="group___debug.html#g8e1adc47649ad13736bd7e453608f4e6">00195</a> <span class="keywordtype">int</span> <a class="code" href="group___debug.html#g8e1adc47649ad13736bd7e453608f4e6" title="Returns whether the Debug system is set to send its messages over USB.">Debug_GetUsb</a>( )
<a name="l00196"></a>00196 {
<a name="l00197"></a>00197   <span class="keywordflow">if</span> ( !<a class="code" href="group___debug.html#gb01e4ab7a088fd347436b32c0d0289af" title="Returns the active state of the Debug subsystem.">Debug_GetActive</a>() )
<a name="l00198"></a>00198     <a class="code" href="group___debug.html#ga064859b9d698661239260fc7ae4b788" title="Sets whether the Debug subsystem is active.">Debug_SetActive</a>( 1 );
<a name="l00199"></a>00199   <span class="keywordflow">return</span> DebugData-&gt;usb;
<a name="l00200"></a>00200 }
<a name="l00201"></a>00201 <span class="comment"></span>
<a name="l00202"></a>00202 <span class="comment">/**</span>
<a name="l00203"></a>00203 <span class="comment">  Sets whether the Debug system is set to send its messages over UDP.</span>
<a name="l00204"></a>00204 <span class="comment">  This is enabled by default.</span>
<a name="l00205"></a>00205 <span class="comment">  @param state An integer specifying the state - 1 (on) or 0 (off).</span>
<a name="l00206"></a>00206 <span class="comment">  @return Zero on success.</span>
<a name="l00207"></a>00207 <span class="comment"></span>
<a name="l00208"></a>00208 <span class="comment">  \par Example</span>
<a name="l00209"></a>00209 <span class="comment">  \code</span>
<a name="l00210"></a>00210 <span class="comment">  // Turn debugging over UDP off.</span>
<a name="l00211"></a>00211 <span class="comment">  Debug_SetUdp( 0 );</span>
<a name="l00212"></a>00212 <span class="comment">  \endcode</span>
<a name="l00213"></a>00213 <span class="comment">*/</span>
<a name="l00214"></a><a class="code" href="group___debug.html#gddf4b54fc8fec7379b39dca13db2f309">00214</a> <span class="keywordtype">int</span> <a class="code" href="group___debug.html#gddf4b54fc8fec7379b39dca13db2f309" title="Sets whether the Debug system is set to send its messages over UDP.">Debug_SetUdp</a>( <span class="keywordtype">int</span> state )
<a name="l00215"></a>00215 {
<a name="l00216"></a>00216   <span class="keywordflow">if</span> ( !<a class="code" href="group___debug.html#gb01e4ab7a088fd347436b32c0d0289af" title="Returns the active state of the Debug subsystem.">Debug_GetActive</a>() )
<a name="l00217"></a>00217     <a class="code" href="group___debug.html#ga064859b9d698661239260fc7ae4b788" title="Sets whether the Debug subsystem is active.">Debug_SetActive</a>( 1 );
<a name="l00218"></a>00218   DebugData-&gt;udp = state;
<a name="l00219"></a>00219   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00220"></a>00220 }
<a name="l00221"></a>00221 <span class="comment"></span>
<a name="l00222"></a>00222 <span class="comment">/**</span>
<a name="l00223"></a>00223 <span class="comment">  Sets whether the Debug subsystem outputs its OSC messages via USB.</span>
<a name="l00224"></a>00224 <span class="comment">  This is enabled by default.</span>
<a name="l00225"></a>00225 <span class="comment">  @return state An integer specifying whether messages will be sent over USB - 1 (enabled) or 0 (disabled).</span>
<a name="l00226"></a>00226 <span class="comment"></span>
<a name="l00227"></a>00227 <span class="comment">  \par Example</span>
<a name="l00228"></a>00228 <span class="comment">  \code</span>
<a name="l00229"></a>00229 <span class="comment">  // Check whether we're sending Debug messages over UDP</span>
<a name="l00230"></a>00230 <span class="comment">  int udp_debug = Debug_GetUdp( );</span>
<a name="l00231"></a>00231 <span class="comment">  \endcode</span>
<a name="l00232"></a>00232 <span class="comment">*/</span>
<a name="l00233"></a><a class="code" href="group___debug.html#g220f51e83f05db634d48ea79cd58a174">00233</a> <span class="keywordtype">int</span> <a class="code" href="group___debug.html#g220f51e83f05db634d48ea79cd58a174" title="Sets whether the Debug subsystem outputs its OSC messages via USB.">Debug_GetUdp</a>( )
<a name="l00234"></a>00234 {
<a name="l00235"></a>00235   <span class="keywordflow">if</span> ( !<a class="code" href="group___debug.html#gb01e4ab7a088fd347436b32c0d0289af" title="Returns the active state of the Debug subsystem.">Debug_GetActive</a>() )
<a name="l00236"></a>00236     <a class="code" href="group___debug.html#ga064859b9d698661239260fc7ae4b788" title="Sets whether the Debug subsystem is active.">Debug_SetActive</a>( 1 );
<a name="l00237"></a>00237 
<a name="l00238"></a>00238   <span class="keywordflow">return</span> DebugData-&gt;udp;
<a name="l00239"></a>00239 }
<a name="l00240"></a>00240 <span class="comment"></span>
<a name="l00241"></a>00241 <span class="comment">/**</span>
<a name="l00242"></a>00242 <span class="comment">  Create a debug message.</span>
<a name="l00243"></a>00243 <span class="comment">  @param level An integer specifying the debug level.  </span>
<a name="l00244"></a>00244 <span class="comment">  @param format printf()-style formatting. %d, %s, %x, etc.</span>
<a name="l00245"></a>00245 <span class="comment">  @param ... The contents of the debug message - this can look just like a call to printf().</span>
<a name="l00246"></a>00246 <span class="comment"></span>
<a name="l00247"></a>00247 <span class="comment">  \par Example</span>
<a name="l00248"></a>00248 <span class="comment">  \code</span>
<a name="l00249"></a>00249 <span class="comment">  // send a simple debug message...</span>
<a name="l00250"></a>00250 <span class="comment">  Debug( DEBUG_MESSAGE, "%s", "Hello." );</span>
<a name="l00251"></a>00251 <span class="comment"></span>
<a name="l00252"></a>00252 <span class="comment">  // or a slightly more interesting message</span>
<a name="l00253"></a>00253 <span class="comment">  SomeTask( void* p )</span>
<a name="l00254"></a>00254 <span class="comment">  {</span>
<a name="l00255"></a>00255 <span class="comment">    int counter = 0;</span>
<a name="l00256"></a>00256 <span class="comment">    while( 1 )</span>
<a name="l00257"></a>00257 <span class="comment">    {</span>
<a name="l00258"></a>00258 <span class="comment">      Debug( DEBUG_MESSAGE, "%s %d", "Current count is: ", counter++ );</span>
<a name="l00259"></a>00259 <span class="comment">      Sleep( 1000 );</span>
<a name="l00260"></a>00260 <span class="comment">    }</span>
<a name="l00261"></a>00261 <span class="comment">  }</span>
<a name="l00262"></a>00262 <span class="comment">  \endcode</span>
<a name="l00263"></a>00263 <span class="comment"></span>
<a name="l00264"></a>00264 <span class="comment">  @return </span>
<a name="l00265"></a>00265 <span class="comment">*/</span>
<a name="l00266"></a>00266 
<a name="l00267"></a><a class="code" href="group___debug.html#g17dd929959ff7576dbccb05e4b69a012">00267</a> <span class="keywordtype">int</span> <a class="code" href="group___debug.html#g17dd929959ff7576dbccb05e4b69a012" title="Create a debug message.">Debug</a>( <span class="keywordtype">int</span> level, <span class="keywordtype">char</span>* format, ... )
<a name="l00268"></a>00268 {
<a name="l00269"></a>00269   va_list args;
<a name="l00270"></a>00270 
<a name="l00271"></a>00271   <span class="keywordflow">if</span> ( !<a class="code" href="group___debug.html#gb01e4ab7a088fd347436b32c0d0289af" title="Returns the active state of the Debug subsystem.">Debug_GetActive</a>() )
<a name="l00272"></a>00272     <a class="code" href="group___debug.html#ga064859b9d698661239260fc7ae4b788" title="Sets whether the Debug subsystem is active.">Debug_SetActive</a>( 1 );
<a name="l00273"></a>00273 
<a name="l00274"></a>00274   <span class="keywordflow">if</span> ( Osc_GetActive() &amp;&amp; Osc_GetRunning( ) &amp;&amp; level &lt;= DebugData-&gt;level )
<a name="l00275"></a>00275   {
<a name="l00276"></a>00276     va_start( args, format );
<a name="l00277"></a>00277     vsnprintf( DebugData-&gt;message, DEBUG_MAX_MESSAGE, format, args ); 
<a name="l00278"></a>00278     <span class="comment">// va_end( args );</span>
<a name="l00279"></a>00279 <span class="preprocessor">    #ifdef MAKE_CTRL_USB</span>
<a name="l00280"></a>00280 <span class="preprocessor"></span>    <span class="keywordflow">if</span> ( DebugData-&gt;usb &amp;&amp; <a class="code" href="group___u_s_b.html#g86fb085b1eace675a46d72e58c98fa09" title="Read the active state of the Usb system.">Usb_GetActive</a>() )
<a name="l00281"></a>00281     {
<a name="l00282"></a>00282       Osc_CreateMessage( OSC_CHANNEL_USB, <span class="stringliteral">"/debug/message"</span>, <span class="stringliteral">",s"</span>, DebugData-&gt;message );
<a name="l00283"></a>00283       Osc_SendPacket( OSC_CHANNEL_USB );
<a name="l00284"></a>00284     }
<a name="l00285"></a>00285 <span class="preprocessor">    #endif</span>
<a name="l00286"></a>00286 <span class="preprocessor"></span><span class="preprocessor">    #ifdef MAKE_CTRL_NETWORK</span>
<a name="l00287"></a>00287 <span class="preprocessor"></span>    <span class="keywordflow">if</span> ( DebugData-&gt;udp &amp;&amp; <a class="code" href="group___network.html#gb1f4725187ab9011d327ed8e05e4746c" title="Returns the active state of the Network subsystem.">Network_GetActive</a>() )
<a name="l00288"></a>00288     {
<a name="l00289"></a>00289       Osc_CreateMessage( OSC_CHANNEL_UDP, <span class="stringliteral">"/debug/message"</span>, <span class="stringliteral">",s"</span>, DebugData-&gt;message );
<a name="l00290"></a>00290       Osc_SendPacket( OSC_CHANNEL_UDP );
<a name="l00291"></a>00291     }
<a name="l00292"></a>00292 <span class="preprocessor">    #endif</span>
<a name="l00293"></a>00293 <span class="preprocessor"></span>  }
<a name="l00294"></a>00294   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00295"></a>00295 }
<a name="l00296"></a>00296 
<a name="l00297"></a>00297 <span class="comment"></span>
<a name="l00298"></a>00298 <span class="comment">/** @}</span>
<a name="l00299"></a>00299 <span class="comment">*/</span>
<a name="l00300"></a>00300 <span class="comment"></span>
<a name="l00301"></a>00301 <span class="comment">/** \defgroup DebugOSC Debug - OSC</span>
<a name="l00302"></a>00302 <span class="comment">  Debug allows sending/receiving debug messages via OSC.</span>
<a name="l00303"></a>00303 <span class="comment">  By default debug messages are sent over both USB and UDP, but this can be modified.</span>
<a name="l00304"></a>00304 <span class="comment">  \ingroup OSC</span>
<a name="l00305"></a>00305 <span class="comment">   </span>
<a name="l00306"></a>00306 <span class="comment">    \section devices Devices</span>
<a name="l00307"></a>00307 <span class="comment">    There's only one Debug system, so a device index is not used in OSC messages to it.</span>
<a name="l00308"></a>00308 <span class="comment">   </span>
<a name="l00309"></a>00309 <span class="comment">    \section properties Properties</span>
<a name="l00310"></a>00310 <span class="comment">    Debug has six properties - \b active, \b level, \b usb, and \b udp.</span>
<a name="l00311"></a>00311 <span class="comment"></span>
<a name="l00312"></a>00312 <span class="comment">    \par Active</span>
<a name="l00313"></a>00313 <span class="comment">    The \b 'active' property corresponds to the active state of the Debug system.</span>
<a name="l00314"></a>00314 <span class="comment">    If Debug is set to be inactive, it will not respond to any other OSC messages. </span>
<a name="l00315"></a>00315 <span class="comment">    If you're not seeing appropriate</span>
<a name="l00316"></a>00316 <span class="comment">    responses to your messages to Debug, check the whether it's</span>
<a name="l00317"></a>00317 <span class="comment">    active by sending a message like</span>
<a name="l00318"></a>00318 <span class="comment">    \verbatim /debug/active \endverbatim</span>
<a name="l00319"></a>00319 <span class="comment">    \par</span>
<a name="l00320"></a>00320 <span class="comment">    You can set the active flag by sending</span>
<a name="l00321"></a>00321 <span class="comment">    \verbatim /debug/active 1 \endverbatim</span>
<a name="l00322"></a>00322 <span class="comment">    </span>
<a name="l00323"></a>00323 <span class="comment">    \par Level</span>
<a name="l00324"></a>00324 <span class="comment">    The \b level property corresponds to the level of detail of the debug messages you want to receive.</span>
<a name="l00325"></a>00325 <span class="comment">    Typically in a debug system, low-level messages are given a low number and higher-level messages</span>
<a name="l00326"></a>00326 <span class="comment">    get higher numbers.  So, if you don't need to see all the low level stuff, you can simply set the debug</span>
<a name="l00327"></a>00327 <span class="comment">    level to a higher number so you're not flooded with tons of nitty gritty messages.</span>
<a name="l00328"></a>00328 <span class="comment"></span>
<a name="l00329"></a>00329 <span class="comment">    Values for the levels:</span>
<a name="l00330"></a>00330 <span class="comment">    - 0 - Always send</span>
<a name="l00331"></a>00331 <span class="comment">    - 1 - Error messages</span>
<a name="l00332"></a>00332 <span class="comment">    - 2 - Warning messages</span>
<a name="l00333"></a>00333 <span class="comment">    - 3 - Normal/test messages</span>
<a name="l00334"></a>00334 <span class="comment">    </span>
<a name="l00335"></a>00335 <span class="comment">    The default debug level is \b 3.  Set the level by sending a message like:</span>
<a name="l00336"></a>00336 <span class="comment">    \verbatim /debug/level 2 \endverbatim</span>
<a name="l00337"></a>00337 <span class="comment">   </span>
<a name="l00338"></a>00338 <span class="comment">    \par Usb</span>
<a name="l00339"></a>00339 <span class="comment">    The \b usb property determines whether debug messages will be sent over USB.  This is turned on</span>
<a name="l00340"></a>00340 <span class="comment">    by default.</span>
<a name="l00341"></a>00341 <span class="comment"></span>
<a name="l00342"></a>00342 <span class="comment">    To set this to off, send a message like:</span>
<a name="l00343"></a>00343 <span class="comment">    \code /debug/usb 0 \endcode</span>
<a name="l00344"></a>00344 <span class="comment">   </span>
<a name="l00345"></a>00345 <span class="comment">    \par Udp</span>
<a name="l00346"></a>00346 <span class="comment">    The \b udp property determines whether debug messages will be sent over UDP.  This is turned on</span>
<a name="l00347"></a>00347 <span class="comment">    by default.</span>
<a name="l00348"></a>00348 <span class="comment"></span>
<a name="l00349"></a>00349 <span class="comment">    To set this to off, send a message like:</span>
<a name="l00350"></a>00350 <span class="comment">    \code /debug/udp 0 \endcode</span>
<a name="l00351"></a>00351 <span class="comment">*/</span>
<a name="l00352"></a>00352 
<a name="l00353"></a>00353 <span class="preprocessor">#include "osc.h"</span>
<a name="l00354"></a>00354 <span class="preprocessor">#include "string.h"</span>
<a name="l00355"></a>00355 <span class="preprocessor">#include "stdio.h"</span>
<a name="l00356"></a>00356 
<a name="l00357"></a>00357 <span class="comment">// OSC Interface </span>
<a name="l00358"></a>00358 <span class="comment">//const char* DebugOsc_GetName( void );</span>
<a name="l00359"></a>00359 <span class="comment">//int DebugOsc_ReceiveMessage( int channel, char* message, int length );</span>
<a name="l00360"></a>00360 
<a name="l00361"></a>00361 <span class="comment">// Need a list of property names</span>
<a name="l00362"></a>00362 <span class="comment">// MUST end in zero</span>
<a name="l00363"></a>00363 <span class="keyword">static</span> <span class="keywordtype">char</span>* DebugOsc_Name = <span class="stringliteral">"debug"</span>;
<a name="l00364"></a>00364 <span class="keyword">static</span> <span class="keywordtype">char</span>* DebugOsc_PropertyNames[] = { <span class="stringliteral">"active"</span>, <span class="stringliteral">"level"</span>, <span class="stringliteral">"usb"</span>, <span class="stringliteral">"udp"</span>, 0 }; <span class="comment">// must have a trailing 0</span>
<a name="l00365"></a>00365 
<a name="l00366"></a>00366 <span class="keywordtype">int</span> DebugOsc_PropertySet( <span class="keywordtype">int</span> property, <span class="keywordtype">int</span> value );
<a name="l00367"></a>00367 <span class="keywordtype">int</span> DebugOsc_PropertyGet( <span class="keywordtype">int</span> property );
<a name="l00368"></a>00368 
<a name="l00369"></a>00369 <span class="comment">// Returns the name of the subsystem</span>
<a name="l00370"></a>00370 <span class="keyword">const</span> <span class="keywordtype">char</span>* DebugOsc_GetName( )
<a name="l00371"></a>00371 {
<a name="l00372"></a>00372   <span class="keywordflow">return</span> DebugOsc_Name;
<a name="l00373"></a>00373 }
<a name="l00374"></a>00374 
<a name="l00375"></a>00375 <span class="comment">// Now getting a message.  This is actually a part message, with the first</span>
<a name="l00376"></a>00376 <span class="comment">// part (the subsystem) already parsed off.</span>
<a name="l00377"></a>00377 <span class="keywordtype">int</span> DebugOsc_ReceiveMessage( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length )
<a name="l00378"></a>00378 {
<a name="l00379"></a>00379   <span class="keywordflow">return</span> <a class="code" href="group___o_s_c_a_p_i.html#g9331ca23d8e81ba91c4e728f0470627e" title="Receive an integer for a subsystem with no indexes.">Osc_IntReceiverHelper</a>( channel, message, length, 
<a name="l00380"></a>00380                                 DebugOsc_Name,
<a name="l00381"></a>00381                                 DebugOsc_PropertySet, DebugOsc_PropertyGet, 
<a name="l00382"></a>00382                                 DebugOsc_PropertyNames );
<a name="l00383"></a>00383 }
<a name="l00384"></a>00384 
<a name="l00385"></a>00385 <span class="comment">// Set the index LED, property with the value</span>
<a name="l00386"></a>00386 <span class="keywordtype">int</span> DebugOsc_PropertySet( <span class="keywordtype">int</span> property, <span class="keywordtype">int</span> value )
<a name="l00387"></a>00387 {
<a name="l00388"></a>00388   <span class="keywordflow">switch</span> ( property )
<a name="l00389"></a>00389   {
<a name="l00390"></a>00390     <span class="keywordflow">case</span> 0: 
<a name="l00391"></a>00391       <a class="code" href="group___debug.html#ga064859b9d698661239260fc7ae4b788" title="Sets whether the Debug subsystem is active.">Debug_SetActive</a>( value );
<a name="l00392"></a>00392       <span class="keywordflow">break</span>;      
<a name="l00393"></a>00393     <span class="keywordflow">case</span> 1:
<a name="l00394"></a>00394       <a class="code" href="group___debug.html#gaabc49f1a610be9aa9965a48fd1a3598" title="Sets the debug level.">Debug_SetLevel</a>( value );
<a name="l00395"></a>00395       <span class="keywordflow">break</span>;
<a name="l00396"></a>00396     <span class="keywordflow">case</span> 2:
<a name="l00397"></a>00397       <a class="code" href="group___debug.html#g699ec173477cc72845e9c35d9c521dcb" title="Sets whether the Debug subsystem outputs its OSC messages via USB.">Debug_SetUsb</a>( value );
<a name="l00398"></a>00398       <span class="keywordflow">break</span>;
<a name="l00399"></a>00399     <span class="keywordflow">case</span> 3:
<a name="l00400"></a>00400       <a class="code" href="group___debug.html#gddf4b54fc8fec7379b39dca13db2f309" title="Sets whether the Debug system is set to send its messages over UDP.">Debug_SetUdp</a>( value );
<a name="l00401"></a>00401       <span class="keywordflow">break</span>;
<a name="l00402"></a>00402   }
<a name="l00403"></a>00403   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00404"></a>00404 }
<a name="l00405"></a>00405 
<a name="l00406"></a>00406 <span class="comment">// Get the index LED, property</span>
<a name="l00407"></a>00407 <span class="keywordtype">int</span> DebugOsc_PropertyGet( <span class="keywordtype">int</span> property )
<a name="l00408"></a>00408 {
<a name="l00409"></a>00409   <span class="keywordtype">int</span> value = 0;
<a name="l00410"></a>00410   <span class="keywordflow">switch</span> ( property )
<a name="l00411"></a>00411   {
<a name="l00412"></a>00412     <span class="keywordflow">case</span> 0:
<a name="l00413"></a>00413       value = <a class="code" href="group___debug.html#gb01e4ab7a088fd347436b32c0d0289af" title="Returns the active state of the Debug subsystem.">Debug_GetActive</a>( );
<a name="l00414"></a>00414       <span class="keywordflow">break</span>;
<a name="l00415"></a>00415     <span class="keywordflow">case</span> 1:
<a name="l00416"></a>00416       value = <a class="code" href="group___debug.html#ga85d6c6d14873ce098a225bf5aab08ab" title="Read the current debugger level.">Debug_GetLevel</a>( );
<a name="l00417"></a>00417       <span class="keywordflow">break</span>;
<a name="l00418"></a>00418     <span class="keywordflow">case</span> 2:
<a name="l00419"></a>00419       value = <a class="code" href="group___debug.html#g8e1adc47649ad13736bd7e453608f4e6" title="Returns whether the Debug system is set to send its messages over USB.">Debug_GetUsb</a>( );
<a name="l00420"></a>00420       <span class="keywordflow">break</span>;  
<a name="l00421"></a>00421     <span class="keywordflow">case</span> 3:
<a name="l00422"></a>00422       value = <a class="code" href="group___debug.html#g220f51e83f05db634d48ea79cd58a174" title="Sets whether the Debug subsystem outputs its OSC messages via USB.">Debug_GetUdp</a>( );
<a name="l00423"></a>00423       <span class="keywordflow">break</span>;  
<a name="l00424"></a>00424   }
<a name="l00425"></a>00425   <span class="keywordflow">return</span> value;
<a name="l00426"></a>00426 }
<a name="l00427"></a>00427 
<a name="l00428"></a>00428 <span class="preprocessor">#endif // OSC</span>
<a name="l00429"></a>00429 <span class="preprocessor"></span>
<a name="l00430"></a>00430 
</pre></div><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit</title>
<style type="text/css">
<!--
.footer {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 9pt;
	color: #999999;
}
-->
</style>
</head>

<body>
<hr size="1">
<div>
  <p class="footer">The Make Controller Kit is an open source project maintained by <a href="http://www.makingthings.com">MakingThings</a>.<br />
    MakingThings code is released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html" target="_blank">Apache 2.0 license</a>.<br />
    Bug tracker, development wiki and status can be found at <a href="http://dev.makingthings.com">http://dev.makingthings.com</a>.<br />
		This document was last updated on 5 Dec 2007.
</p>
</div>
<!-- Google Analytics Code -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-769030-1";
urchinTracker();
</script>
</body>
</html>
